<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>package frc3128.EventManager;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>import frc3128.Util.DebugLog;<a name="line.3"></a>
<span class="sourceLineNo">004</span><a name="line.4"></a>
<span class="sourceLineNo">005</span>/**<a name="line.5"></a>
<span class="sourceLineNo">006</span> *<a name="line.6"></a>
<span class="sourceLineNo">007</span> * @author Noah Sutton-Smolin<a name="line.7"></a>
<span class="sourceLineNo">008</span> */<a name="line.8"></a>
<span class="sourceLineNo">009</span>final class TimerEvent extends Event {<a name="line.9"></a>
<span class="sourceLineNo">010</span>    private Event linkedEvent;<a name="line.10"></a>
<span class="sourceLineNo">011</span>    private long targetTimeMillis = -1;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>    public final void setTargetTime(long millis) {<a name="line.13"></a>
<span class="sourceLineNo">014</span>        DebugLog.log(DebugLog.LVL_STREAM, this, "Event " + linkedEvent.toString() + " set for " + millis + " msec from now.");<a name="line.14"></a>
<span class="sourceLineNo">015</span>        targetTimeMillis = System.currentTimeMillis() + millis;<a name="line.15"></a>
<span class="sourceLineNo">016</span>        if(EventManager.containsEvent(this)) {<a name="line.16"></a>
<span class="sourceLineNo">017</span>            DebugLog.log(DebugLog.LVL_WARN, this, "The timer was set while it was running and before it expired! Deleting old copy...");<a name="line.17"></a>
<span class="sourceLineNo">018</span>            EventManager.removeEvent(this);<a name="line.18"></a>
<span class="sourceLineNo">019</span>        }<a name="line.19"></a>
<span class="sourceLineNo">020</span>        EventManager.addContinuousEvent(this);<a name="line.20"></a>
<span class="sourceLineNo">021</span>    }<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>    private void destroyTimer() {<a name="line.23"></a>
<span class="sourceLineNo">024</span>        targetTimeMillis = -1;<a name="line.24"></a>
<span class="sourceLineNo">025</span>        EventManager.removeEvent(this);<a name="line.25"></a>
<span class="sourceLineNo">026</span>    }<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>    public final void execute() {<a name="line.28"></a>
<span class="sourceLineNo">029</span>        if (targetTimeMillis == -1) {<a name="line.29"></a>
<span class="sourceLineNo">030</span>            DebugLog.log(DebugLog.LVL_SEVERE, this, "Timer set without valid time!");<a name="line.30"></a>
<span class="sourceLineNo">031</span>            this.destroyTimer();<a name="line.31"></a>
<span class="sourceLineNo">032</span>        }<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>        if (System.currentTimeMillis() &gt; targetTimeMillis) {<a name="line.34"></a>
<span class="sourceLineNo">035</span>            DebugLog.log(DebugLog.LVL_STREAM, this, "Running timed event " + this.linkedEvent.toString());<a name="line.35"></a>
<span class="sourceLineNo">036</span>            linkedEvent.registerSingleEvent();<a name="line.36"></a>
<span class="sourceLineNo">037</span>            this.destroyTimer();<a name="line.37"></a>
<span class="sourceLineNo">038</span>        }<a name="line.38"></a>
<span class="sourceLineNo">039</span>    }<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>    public final void linkEvent(Event e) {this.linkedEvent = e;}<a name="line.41"></a>
<span class="sourceLineNo">042</span>}<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>final class CancelEvent extends Event {<a name="line.44"></a>
<span class="sourceLineNo">045</span>    private Event linkedEvent;<a name="line.45"></a>
<span class="sourceLineNo">046</span>    <a name="line.46"></a>
<span class="sourceLineNo">047</span>    public CancelEvent(Event l) {this.linkedEvent = l;}<a name="line.47"></a>
<span class="sourceLineNo">048</span>    <a name="line.48"></a>
<span class="sourceLineNo">049</span>    public void execute() {<a name="line.49"></a>
<span class="sourceLineNo">050</span>        linkedEvent.cancelEvent();<a name="line.50"></a>
<span class="sourceLineNo">051</span>        DebugLog.log(DebugLog.LVL_STREAM, this, "Cancelled linked event: " + linkedEvent);<a name="line.51"></a>
<span class="sourceLineNo">052</span>    }<a name="line.52"></a>
<span class="sourceLineNo">053</span>}<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>public abstract class Event {<a name="line.55"></a>
<span class="sourceLineNo">056</span>    private boolean eventIsCancelled;<a name="line.56"></a>
<span class="sourceLineNo">057</span>    private TimerEvent timerEvent = null;<a name="line.57"></a>
<span class="sourceLineNo">058</span>    <a name="line.58"></a>
<span class="sourceLineNo">059</span>    public Event() {}<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>    /**<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * This function is where the event is actually run.<a name="line.62"></a>
<span class="sourceLineNo">063</span>     */<a name="line.63"></a>
<span class="sourceLineNo">064</span>    public abstract void execute();<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>    /**<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * Cancels the event if it is running. If the event is not running, this<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * does nothing. &lt;p&gt; Note: This does NOT cancel a timed event.<a name="line.68"></a>
<span class="sourceLineNo">069</span>     */<a name="line.69"></a>
<span class="sourceLineNo">070</span>    final public void cancelEvent() {<a name="line.70"></a>
<span class="sourceLineNo">071</span>        eventIsCancelled = true;<a name="line.71"></a>
<span class="sourceLineNo">072</span>        DebugLog.log(DebugLog.LVL_STREAM, this, "Event " + this.toString() + " has been cancelled!");<a name="line.72"></a>
<span class="sourceLineNo">073</span>    }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    /**<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * Cancels the event after the timer has expired<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * <a name="line.77"></a>
<span class="sourceLineNo">078</span>     * @param msec the time after which the event will cancel<a name="line.78"></a>
<span class="sourceLineNo">079</span>     */<a name="line.79"></a>
<span class="sourceLineNo">080</span>    final public void cancelEventAfter(int msec) {<a name="line.80"></a>
<span class="sourceLineNo">081</span>        DebugLog.log(DebugLog.LVL_STREAM, this, "Canceling self by trigger after " + msec + " msec.");<a name="line.81"></a>
<span class="sourceLineNo">082</span>        new CancelEvent(this).registerTimedEvent(msec);<a name="line.82"></a>
<span class="sourceLineNo">083</span>    }<a name="line.83"></a>
<span class="sourceLineNo">084</span>    <a name="line.84"></a>
<span class="sourceLineNo">085</span>    /**<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * Cancels the event's timer if it is running. If the timer is not running,<a name="line.86"></a>
<span class="sourceLineNo">087</span>     * this does nothing. &lt;p&gt; Note: This does NOT cancel the event's execution.<a name="line.87"></a>
<span class="sourceLineNo">088</span>     */<a name="line.88"></a>
<span class="sourceLineNo">089</span>    final public void cancelTimedEvent() {<a name="line.89"></a>
<span class="sourceLineNo">090</span>        timerEvent.cancelEvent();<a name="line.90"></a>
<span class="sourceLineNo">091</span>    }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span>    final protected boolean shouldRun() {<a name="line.93"></a>
<span class="sourceLineNo">094</span>        return !eventIsCancelled;<a name="line.94"></a>
<span class="sourceLineNo">095</span>    }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span>    /**<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * Adds the event to the EventManager's queue as a single-run event. This<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * event will be run once, and then removed from the queue.<a name="line.99"></a>
<span class="sourceLineNo">100</span>     */<a name="line.100"></a>
<span class="sourceLineNo">101</span>    final public void registerSingleEvent() {<a name="line.101"></a>
<span class="sourceLineNo">102</span>        this.eventIsCancelled = false;<a name="line.102"></a>
<span class="sourceLineNo">103</span>        EventManager.addSingleEvent(this);<a name="line.103"></a>
<span class="sourceLineNo">104</span>    }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    /**<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * Adds the event to the EventManager's queue as an iterable event. This<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * event will not be deleted from the queue once it has been run; it will be<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * run every iteration. It must be canceled explicitly.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     */<a name="line.110"></a>
<span class="sourceLineNo">111</span>    final public void registerIterableEvent() {<a name="line.111"></a>
<span class="sourceLineNo">112</span>        this.eventIsCancelled = false;<a name="line.112"></a>
<span class="sourceLineNo">113</span>        EventManager.addContinuousEvent(this);<a name="line.113"></a>
<span class="sourceLineNo">114</span>    }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span>    /**<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * Starts the event's linked TimerEvent. The TimerEvent is an iterable<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * event. Each iteration the TimerEvent will check to see if the time has<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * expired; if it has, it will run the current event as a SingleEvent. &lt;p&gt;<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * Note: If the timer has not been created, then it will be created when<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * this method is first called. <a name="line.121"></a>
<span class="sourceLineNo">122</span>     *<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * @param msec the time in milliseconds after which the event will execute.<a name="line.123"></a>
<span class="sourceLineNo">124</span>     */<a name="line.124"></a>
<span class="sourceLineNo">125</span>    final public void registerTimedEvent(int msec) {<a name="line.125"></a>
<span class="sourceLineNo">126</span>        if (timerEvent == null) {<a name="line.126"></a>
<span class="sourceLineNo">127</span>            this.timerEvent = new TimerEvent();<a name="line.127"></a>
<span class="sourceLineNo">128</span>            timerEvent.linkEvent(this);<a name="line.128"></a>
<span class="sourceLineNo">129</span>        }<a name="line.129"></a>
<span class="sourceLineNo">130</span>        timerEvent.setTargetTime(msec);<a name="line.130"></a>
<span class="sourceLineNo">131</span>    }<a name="line.131"></a>
<span class="sourceLineNo">132</span>}<a name="line.132"></a>




























































</pre>
</div>
</body>
</html>
